// 版权归Go作者所有。版权所有。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

package filepath

import (
	"errors"
	"os"
	"runtime"
	"sort"
	"strings"
	"unicode/utf8"
)

// ErrBadPattern表示模式格式不正确。
var ErrBadPattern = errors.New("syntax error in pattern")

// Match报告名称是否与shell文件名模式匹配。
// 模式语法为：
// 
// 模式：
// /{term}
// /term:
// /'*'匹配任何非分隔字符序列
// /'？'匹配任何单个非分隔字符
// character class（必须为非空）
// c匹配字符c（c！='*'、'？'、'\\'、'['）
// '\'c匹配字符c 
// 
// 字符范围：
// c匹配字符c（c！=''\\\'''''\'''''''''-'，''''.]]
// '\\'c匹配字符c 
// lo'-'hi匹配字符c，lo<=c<=hi 
// 
// /匹配要求模式匹配所有名称，而不仅仅是子字符串。
// 当模式
// 格式不正确时，唯一可能返回的错误是ErrBadPattern。
// 
// 在Windows上，转义被禁用。相反，\\'被视为
// 路径分隔符。
// 
func Match(pattern, name string) (matched bool, err error) {
Pattern:
	for len(pattern) > 0 {
		var star bool
		var chunk string
		star, chunk, pattern = scanChunk(pattern)
		if star && chunk == "" {
			// 尾部*匹配字符串的其余部分，除非它有一个/。
			return !strings.Contains(name, string(Separator)), nil
		}
		// 在当前位置查找匹配项。
		t, ok, err := matchChunk(chunk, name)
		// 如果我们是最后一个区块，请确保我们已用尽名称
		// 否则，即使我们仍然可以匹配
		// 使用星型
		if ok && (len(t) == 0 || len(pattern) > 0) {
			name = t
			continue
		}
		if err != nil {
			return false, err
		}
		if star {
			// 查找跳过i+1字节的匹配，我们也会给出错误结果。
			// 不能跳过/。
			for i := 0; i < len(name) && name[i] != Separator; i++ {
				t, ok, err := matchChunk(chunk, name[i+1:])
				if ok {
					// 如果我们是最后一个区块，请确保我们已用尽名称
					if len(pattern) == 0 && len(t) > 0 {
						continue
					}
					name = t
					continue Pattern
				}
				if err != nil {
					return false, err
				}
			}
		}
		return false, nil
	}
	return len(name) == 0, nil
}

// scanChunk获取模式的下一段，这是一个非星号字符串
// 可能前面有星号。
func scanChunk(pattern string) (star bool, chunk, rest string) {
	for len(pattern) > 0 && pattern[0] == '*' {
		pattern = pattern[1:]
		star = true
	}
	inrange := false
	var i int
Scan:
	for i = 0; i < len(pattern); i++ {
		switch pattern[i] {
		case '\\':
			if runtime.GOOS != "windows" {
				// 在matchChunk中处理的错误检查：错误模式。
				if i+1 < len(pattern) {
					i++
				}
			}
		case '[':
			inrange = true
		case ']':
			inrange = false
		case '*':
			if !inrange {
				break Scan
			}
		}
	}
	return star, pattern[0:i], pattern[i:]
}

// matchChunk检查chunk是否匹配s的开头。
// 如果是，则返回s的剩余部分（匹配后）。
// Chunk是所有单字符运算符：文本、字符类和？。
func matchChunk(chunk, s string) (rest string, ok bool, err error) {
	// 失败记录匹配是否失败。
	// 匹配失败后，循环继续处理区块，
	// 检查模式是否格式正确，但不再读取s。
	failed := false
	for len(chunk) > 0 {
		if !failed && len(s) == 0 {
			failed = true
		}
		switch chunk[0] {
		case '[':
			// 字符类
			var r rune
			if !failed {
				var n int
				r, n = utf8.DecodeRuneInString(s)
				s = s[n:]
			}
			chunk = chunk[1:]
			// 可能被否定的
			negated := false
			if len(chunk) > 0 && chunk[0] == '^' {
				negated = true
				chunk = chunk[1:]
			}
			// 解析所有范围
			match := false
			nrange := 0
			for {
				if len(chunk) > 0 && chunk[0] == ']' && nrange > 0 {
					chunk = chunk[1:]
					break
				}
				var lo, hi rune
				if lo, chunk, err = getEsc(chunk); err != nil {
					return "", false, err
				}
				hi = lo
				if chunk[0] == '-' {
					if hi, chunk, err = getEsc(chunk[1:]); err != nil {
						return "", false, err
					}
				}
				if lo <= r && r <= hi {
					match = true
				}
				nrange++
			}
			if match == negated {
				failed = true
			}

		case '?':
			if !failed {
				if s[0] == Separator {
					failed = true
				}
				_, n := utf8.DecodeRuneInString(s)
				s = s[n:]
			}
			chunk = chunk[1:]

		case '\\':
			if runtime.GOOS != "windows" {
				chunk = chunk[1:]
				if len(chunk) == 0 {
					return "", false, ErrBadPattern
				}
			}
			fallthrough

		default:
			if !failed {
				if chunk[0] != s[0] {
					failed = true
				}
				s = s[1:]
			}
			chunk = chunk[1:]
		}
	}
	if failed {
		return "", false, nil
	}
	return s, true, nil
}

// getEsc为字符类从块中获取可能转义的字符。
func getEsc(chunk string) (r rune, nchunk string, err error) {
	if len(chunk) == 0 || chunk[0] == '-' || chunk[0] == ']' {
		err = ErrBadPattern
		return
	}
	if chunk[0] == '\\' && runtime.GOOS != "windows" {
		chunk = chunk[1:]
		if len(chunk) == 0 {
			err = ErrBadPattern
			return
		}
	}
	r, n := utf8.DecodeRuneInString(chunk)
	if r == utf8.RuneError && n == 1 {
		err = ErrBadPattern
	}
	nchunk = chunk[n:]
	if len(nchunk) == 0 {
		err = ErrBadPattern
	}
	return
}

// Glob返回与模式匹配的所有文件的名称，如果没有匹配的文件，则返回nil 
// 。模式的语法与Match中的语法相同。模式可以描述分层名称，例如
// /usr/*/bin/ed（假设分隔符为“/”）。
// 
// Glob忽略文件系统错误，例如读取目录时的I/O错误。
// 当模式
// 格式不正确时，唯一可能返回的错误是ErrBadPattern。
func Glob(pattern string) (matches []string, err error) {
	// 检查模式格式正确。
	if _, err := Match(pattern, ""); err != nil {
		return nil, err
	}
	if !hasMeta(pattern) {
		if _, err = os.Lstat(pattern); err != nil {
			return nil, nil
		}
		return []string{pattern}, nil
	}

	dir, file := Split(pattern)
	volumeLen := 0
	if runtime.GOOS == "windows" {
		volumeLen, dir = cleanGlobPathWindows(dir)
	} else {
		dir = cleanGlobPath(dir)
	}

	if !hasMeta(dir[volumeLen:]) {
		return glob(dir, file, nil)
	}

	// 防止无限递归。见第15879期。
	if dir == pattern {
		return nil, ErrBadPattern
	}

	var m []string
	m, err = Glob(dir)
	if err != nil {
		return
	}
	for _, d := range m {
		matches, err = glob(d, file, matches)
		if err != nil {
			return
		}
	}
	return
}

// cleanGlobPath为全局匹配准备路径。
func cleanGlobPath(path string) string {
	switch path {
	case "":
		return "."
	case string(Separator):
		// 对路径不做任何操作
		return path
	default:
		return path[0 : len(path)-1] // 切掉尾部分隔符
	}
}

// cleanGlobPathWindows是cleanGlobPath的windows版本。
func cleanGlobPathWindows(path string) (prefixLen int, cleaned string) {
	vollen := volumeNameLen(path)
	switch {
	case path == "":
		return 0, "."
	case vollen+1 == len(path) && os.IsPathSeparator(path[len(path)-1]): // 、\、C:\和C:/
		// 对路径不做任何操作
		return vollen + 1, path
	case vollen == len(path) && len(path) == 2: // /C:
		return vollen, path + "." // 将C:转换为C:。
	default:
		if vollen >= len(path) {
			vollen = len(path) - 1
		}
		return vollen, path[0 : len(path)-1] // 切掉尾部分隔符
	}
}

// glob在目录dir 
// 中搜索匹配模式的文件，并将其附加到匹配项中。如果无法打开目录
// 则返回现有匹配项。新的匹配项是
// 按字典顺序添加的。
func glob(dir, pattern string, matches []string) (m []string, e error) {
	m = matches
	fi, err := os.Stat(dir)
	if err != nil {
		return // 忽略I/O错误
	}
	if !fi.IsDir() {
		return // 忽略I/O错误
	}
	d, err := os.Open(dir)
	if err != nil {
		return // 忽略I/O错误
	}
	defer d.Close()

	names, _ := d.Readdirnames(-1)
	sort.Strings(names)

	for _, n := range names {
		matched, err := Match(pattern, n)
		if err != nil {
			return m, err
		}
		if matched {
			m = append(m, Join(dir, n))
		}
	}
	return
}

// hasMeta报告路径是否包含匹配识别的任何魔法字符
// 。
func hasMeta(path string) bool {
	magicChars := `*?[`
	if runtime.GOOS != "windows" {
		magicChars = `*?[\`
	}
	return strings.ContainsAny(path, magicChars)
}
